/*
 * Copyright 2006-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.martinimix.web.servlet.handler.bluemartini;

import javax.servlet.http.HttpServletRequest;

import com.bluemartini.dna.DNAList;

/**
 * Provides an HTTP session based Blue Martini form data accessor.
 *  
 * @author Scott Rossillo
 *
 */
public class HttpSessionBlueMartiniFormDataAccessor implements BlueMartiniFormDataAccessor {
	
	/**
	 * The name of the Http session attribute containing Blue Martini's form data. 
	 */
	protected final static String SESSION_FORM_DATA_ATTRIBUTE = "bluemartini.formData";
	
	private final HttpServletRequest request;
	
	/**
	 * Creates a new session based form data accessor which will access form data
	 * from the given request
	 * 
	 * @param request the <code>HttpServletRequest</code> from which form data will be accessed
	 */
	public HttpSessionBlueMartiniFormDataAccessor(HttpServletRequest request) {
		this.request = request;
	}
	
	/* (non-Javadoc)
	 * @see net.martinimix.web.servlet.handler.bluemartini.BlueMartiniFormDataAccessor#getFormData()
	 */
	public DNAList getFormData() {
		
		return (DNAList) request.getSession().getAttribute(SESSION_FORM_DATA_ATTRIBUTE);
	}

}
